home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / remind16.zip / REMINDME.DOC < prev    next >
Text File  |  1993-03-12  |  16KB  |  365 lines
  1.  
  2.                                REMIND ME !
  3.  
  4.                                   v1.6
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                          (404) 256-9525 (Data)
  12.                          (404) 705-9104 (Data)
  13.                 (404) 256-9518 (Voice, 9am-9:30pm EST)
  14.  
  15.  
  16.  
  17.  
  18.                                 OVERVIEW
  19.                                 ________
  20.  
  21.  
  22.    The REMIND ME! Door allows your callers to enter REMINDERS to themselves.
  23.    They can be reminded daily, on a specific date, a day of the week, on a
  24.    paricular date of the month OR on EVEN or ODD days of the month (in
  25.    essence displaying the Reminder every other day). Reminders are displayed
  26.    to the caller when they open the Door or automatically if you make it an
  27.    Auto Login Door.
  28.  
  29.    SYSOP can leave reminders to ALL, specific Security levels or to
  30.    SPECIFIC USERS!!!!
  31.  
  32.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  33.          created in the directory you run the door from.
  34.  
  35.  
  36.  
  37.                               INSTALLATION
  38.                               ____________
  39.  
  40.  
  41.    Installation is fairly easy and straight-forward. The following steps and
  42.    examples should have you up and running in a very short period of time.
  43.    It is assumed that you are familiar with setting up DOORS on your system.
  44.    To this end, only examples of the configuration file and Door batch file
  45.    are described.
  46.  
  47.       1) Create a directory to hold all REMINDME files
  48.  
  49.       2) Unzip REMINDxx.ZIP into the the above directory
  50.  
  51.       3) Create a configuration file, with a name of your choice, or
  52.          modify the supplied REMINDME.CFG file. A description follows:
  53.  
  54.             **                       Location of system file (See Below)
  55.             SUNRISE-80 BBS           Your BBS Name
  56.             Al                       Sysop's First name
  57.  
  58.             Lawrence                 Sysop's Last Name
  59. |-----------------------------------------------------------------------------|
  60. | READ!     1                        CommPort  \ These 2 lines are required   |
  61. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  62. |-----------------------------------------------------------------------------|
  63.  
  64.             00000000                 Registration Number
  65.  
  66.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  67.                                      2 = Display ADOPT-A-DOOR message
  68.  
  69.             2                        Keyboard timeout value in Minutes
  70.  
  71.             N                        Y =  Use European Date Format (DDMMYY)
  72.                                      N =  Use Regular  Date Format (MMDDYY)
  73.  
  74.            365                       Maximum # of days caller can enter in
  75.                                      response to the number of warning days.
  76.                                      This number will be used to determine how
  77.                                      many days prior to the due to start
  78.                                      displaying the Reminder. (0-365).
  79.                                      0 = No warning days
  80.  
  81.            365                       Maximum # of days caller can enter in
  82.                                      in response to how long the reminder
  83.                                      will remain active (1-365)
  84.  
  85.              0                       Additional Security level that will be
  86.                                      allowed to leave Reminders as if they
  87.                                      were the Sysop (Co-Sysop as an example)
  88.                                      Note: They will NOT be able to Delete or
  89.                                            Modify or Review messages they
  90.                                            entered to a Specific caller or to
  91.                                            All Callers.
  92.  
  93.              Y                       Y = Do    check if caller is ANSI capable
  94.                                      N = DoNot check if caller is ANSI capable
  95.  
  96.  
  97.           NONE                       Drive\path\filename of the file you want
  98.                                      displayed when returning from an AUTO-LOGIN
  99.                                      to the BBS.
  100.  
  101.           NONE                       Drive\Path\Filename of the file you want
  102.                                      displayed when manually exiting the Door
  103.                                      using the Exit option from the Main Menu.
  104.  
  105.               ** = Replace with ONE of the following:
  106.  
  107. C:\BBS\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  108. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  109. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  110.                                    (Note:DOOR.SYS must be in SAME directory)
  111. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  112. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  113. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  114. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  115. C:\BBS\CHAIN.TXT                <- For WWIV systems
  116. C:\BBS\GTUSER.BBS               <- For GT Power
  117.                                    * if using this option you must put the
  118.                                      ComPort # on line 5 and the Node # on
  119.                                      line 6 of the configuration file
  120.  
  121.  
  122.  
  123.            # = Requires registration to change to a different value.
  124.  
  125.                NOTE: There are NO Blank Lines in the Config File!!
  126.  
  127.  
  128.  
  129.  
  130.       4) Create a batch file or modify the REMINDME file supplied. A
  131.          description of this file follows:
  132.  
  133.             ECHO off
  134.             cd\BBS\DOORS\REMINDME     Location of REMINDME files
  135.             REMINDME REMINDME.CFG     EXE filename and CFG filename (Name
  136.                                       used in creating file in #3 above)
  137.             CD\BBS
  138.             BOARD
  139.  
  140.  
  141.        5) When running in more than one node, be sure to supply a
  142.           different configuration name for each node (your choice of name).
  143.  
  144.        6) If running with Fossil-based multi-port boards add
  145.            /FD to the line containing the CFG name as follows:
  146.  
  147.                         REMINDME REMINDME.CFG /FD
  148.  
  149.  
  150.  
  151.                              TRASHCAN File
  152.                              -------------
  153.  
  154.       If you wish to trap any words that you do not want your users to see,
  155.       such as foul language, etc, then you create an ASCII file with the word
  156.       or words. Each word must appear on a separate line, up to a maximum of
  157.       100. The name of the file must be TRASHCAN and must reside in the same
  158.       directory as the REMINDME.EXE file. The program will check ALL
  159.       description lines against the list. If a match is found the offending
  160.       word(s) will be changed to asteriks (*).
  161.  
  162.  
  163.                       AUTO LOGIN OPTION (Registered Version Only)
  164.                       -------------------------------------------
  165.  
  166.       Should you want to take your callers to the REMIND ME Door automatically
  167.       at logon I would suggest that you set up 2 batch files.
  168.  
  169.       One batch file would take the caller to the Door if they selected it off
  170.       your Door Menu. They would be presented with any Reminders that have
  171.       come due AND they will be able to use all the functions of the Door.
  172.       See #4 above for example.
  173.  
  174.       The second batch file would take your caller to the Door, present the
  175.       caller with any Reminders that have come due and immediately return to
  176.       the BBS. REMIND ME will display a file you have defined in the CFG,
  177.       while the system is returning to the BBS. All that would be required
  178.       would be to create another batch file as in #4 above, give it another
  179.       name (I use REMLOGIN, but you do what you have to depending on your
  180.       BBS software) and ADD   $BYPASS$   to the END of the Command line.
  181.  
  182.           Example: REMINDME REMINDME.CFG $BYPASS$
  183.              Note: $BYPASS$ must be the last parameter on the line
  184.                    Everything else in the batch file is the same as #4 above
  185.  
  186.  
  187.                         NON-STANDARD COM SUPPORT
  188.                         ________________________
  189.  
  190.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  191.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  192.       number after the configuration filename. Let's assume your Door is
  193.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  194.       passed to your Door would be:
  195.  
  196.                             FOOBAR FOOBAR.CFG /5
  197.  
  198.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  199.       normally used with COM1. No /x parameter is needed for the standard
  200.       IRQ's.
  201.  
  202.       As an alternative, you may use an environmental variable on the command
  203.       line. To use the variable (following the example above), place a
  204.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  205.       different IRQ number for each node). The command line would now look
  206.       like this:
  207.  
  208.                           FOOBAR FOOBAR.CFG /%IRQ%
  209.  
  210.       This, in combination with the use of the environmental variables
  211.       described in the MULTI-NODE SETUP section will allow you to use one
  212.       batch file and one config file to run this door on all nodes.
  213.  
  214.  
  215.  
  216.  
  217.                            MULTI-NODE SETUP
  218.                            ________________
  219.  
  220.       All Sunrise Doors are Multi-Node capable. Each node must have the
  221.       ability to access a configuration file which will have its own system
  222.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  223.       line. There are 2 ways to accomplish this:
  224.  
  225.       (1) Create a separate configuration file for each node. The only
  226.           difference between each file would be the location of the system
  227.           file for that particular node. For example, on my system there are 2
  228.           nodes and the first line of the config files would look like this:
  229.  
  230.                         NODE1:  H:\PCB1\DOOR.SYS
  231.                         NODE2:  H:\PCB2\DOOR.SYS
  232.  
  233.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  234.  
  235.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  236.           the following PCBoard environmental variables:
  237.  
  238.                  PCBDIR    (Directory containing the System file)
  239.                  PCBDRIVE  (Drive containing the System file)
  240.  
  241.           Thus, the first line of the SINGLE configuration file, for this Door
  242.           would look like this:
  243.  
  244.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  245.  
  246.       NOTE: This option, as described, assumes that you are running PCBoard
  247.             14.5a software. The environmental variables are automatically
  248.             created by the software for each node.
  249.  
  250.             HOWEVER, if you are running other BBS software you should be able
  251.             to set the variables EXACTLY as described below, for EACH node
  252.             (more than likely in each batch file you use to bring up EACH node):
  253.  
  254.                             PCBDRIVE=C:
  255.                             ^^^^^^^^^
  256.                             PCBDIR=\NODE2
  257.                             ^^^^^^^^
  258.  
  259.             Info with a carat (^) under it, MUST be typed as is. The rest
  260.             depends on your naming conventions.
  261.  
  262.             This, in combination with the use of the optional environmental
  263.             variable described in the NON-STANDARD COM SUPPORT section, will
  264.             allow you to use one batch file and one config file to run this
  265.             door on all nodes.
  266.  
  267.  
  268.  
  269.                                ADOPT-A-DOOR
  270.                                ____________
  271.  
  272.     Having been a Sysop for a number of years, I have had my share of problems
  273.     and frustrations getting financial support for my board's upkeep. A fellow
  274.     Sysop left a message on my board, not long ago, about a concept that was
  275.     being used by several boards around the country.
  276.  
  277.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  278.     would be the same as sending in a donation, only this way it is earmarked
  279.     for registering a particular door. In a way, the user feels he/she is
  280.     "getting something in return". As a Door author I have decided to build
  281.     this concept into each of my Door programs. The concept replaces the
  282.     usual message "tell the Sysop to register this Door" we find in most
  283.     doors.
  284.  
  285.     If the Door is unregisterd then a message appears on the opening screen
  286.     to that effect. After finishing or suspending a game, a message screen
  287.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  288.     caller to contact the Sysop to find out if there is any further details
  289.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  290.     time, etc to callers that ADOPT-A-DOOR.
  291.  
  292.     If the Door has been registered, either by the Sysop or other callers,
  293.     the names of those contributors will be displayed in the closing screen.
  294.  
  295.     NOTE: If you want to display the names of the callers that contributed
  296.           to registering the Door, you must create an ASCII file called
  297.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  298.           the name(s) of the contributors (one on each line, maximum of 5
  299.           entries, each a maximum of 30 characters long). This file must be
  300.           saved, in ASCII format, and placed in the Door directory.
  301.  
  302.  
  303.  
  304.                               LEGALITIES
  305.                               __________
  306.  
  307.  
  308.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  309.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  310.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  311.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  312.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  313.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  314.       OR BREACH OF ANY WARRANTY.
  315.  
  316.  
  317.  
  318.  
  319.  
  320.                              DISTRIBUTION
  321.                              ____________
  322.  
  323.    You may make this file available for downloading from your BBS or you may
  324.    upload it to any BBS of your choice, provided that you do not make any
  325.    changes to the contents of the archive (ZIP file). The archive and its
  326.    individual contents may not be used by any service that charges any money
  327.    whatsoever, without the written permission of the author.
  328.  
  329.  
  330.  
  331.  
  332.  
  333.                              REGISTRATION
  334.                              ____________
  335.  
  336.    Registration and the subsequent insertion of the registration number into
  337.    your configuation file, allows for the display of your BBS name on the
  338.    opening and closing screen as well as the reduction of a delay built into
  339.    the opening screen display along with the ability to change certain
  340.    values in the configuration file.
  341.  
  342.    To register your copy of REMINDME, please fill out the registration form
  343.    (REGISTER.FRM) and mail it along with the appropriate registration fee to
  344.    the name and address on the form.
  345.  
  346.    Be sure to use the proper upper/lower case when filling in your name and
  347.    BBS name, as they MUST match the way you entered them in the configuration
  348.    file.             ^^^^
  349.  
  350.    Based upon information supplied on the registration form, I will pre-
  351.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  352.    up your registration number.
  353.  
  354.  
  355.  
  356.                                  MISC
  357.                                  ____
  358.  
  359.    The latest version of REMIND  ME! and other fine SUNRISE DOOR programs
  360.    are always available for download from SUNRISE-80 BBS.
  361.  
  362.    Remember, should you have any problems, questions or suggestions, be sure
  363.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors,
  364.    PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDO 1:133/410.
  365.